Authentication
Compute
- GET[Images] List public operating system images
- GET[Locations] List available datacenter locations
- GET[Locations] Get datacenter location details
- GET[Sizes] List available instance sizes
- GET[Sizes] Get instance size details
- GET[Software] List available software packages
- GET[Software] Get software package details
- GET[Images] List all available images
- GET[Images] Get image details
- PUT[Images] Replace image metadata
- DEL[Images] Delete a private image
- PATCH[Images] Partially update image metadata
- GET[Instances] List all compute instances
- POST[Instances] Create a new compute instance
- GET[Instances] Get compute instance details
- PUT[Instances] Replace compute instance metadata
- DEL[Instances] Delete a compute instance
- PATCH[Instances] Partially update compute instance metadata
- POST[Instances] Activate an addon for a compute instance
- POST[Instances] Request instance cancellation
- GET[Instances] Get active console session
- POST[Instances] Create VNC console session
- GET[Instances] Get console session details
- DEL[Instances] Close a console session
- PATCH[Instances] Change compute instance hostname
- GET[Instances] List billing invoices for an instance
- GET[Monitors] List instance monitors
- POST[Monitors] Create instance monitor
- GET[Monitors] Get instance monitor details
- PUT[Monitors] Update instance monitor
- DEL[Monitors] Delete instance monitor
- POST[Monitors] Run monitor check
- GET[Monitors] List monitor checks
- GET[Monitors] List monitor incidents
- GET[Monitors] Get monitor latency history
- GET[Monitors] Get monitor statistics
- GET[Instances] Get current instance performance metrics
- GET[Instances] Get historical instance performance metrics
- POST[Instances] Reboot a compute instance
- POST[Instances] Reinstall operating system on a compute instance
- POST[Instances] Hard reset a compute instance
- POST[Instances] Resize a compute instance
- POST[Instances] Revoke instance cancellation request
- POST[Instances] Gracefully shutdown a compute instance
- POST[Instances] Start a compute instance
- POST[Instances] Stop a compute instance
- POST[Instances] Reactivate a suspended compute instance
- GET[Alerts] List instance alerts
- GET[Alerts] Retrieve instance alert
- POST[Alerts] Acknowledge instance alert
- POST[Alerts] Resolve instance alert
- GET[Alerts] Get instance alerts summary
- GET[Backups] List all backups for an instance
- POST[Backups] Create a new backup
- GET[Backups] Get backup details
- PUT[Backups] Replace backup metadata
- PATCH[Backups] Partially update backup metadata
- GET[Backups] Get backup download URL
- POST[Backups] Restore an instance from a backup
- GET[Firewall] List all firewall rules for an instance
- POST[Firewall] Create a new firewall rule
- GET[Firewall] Get firewall rule details
- PUT[Firewall] Replace a firewall rule
- DEL[Firewall] Delete a firewall rule
- PATCH[Firewall] Partially update a firewall rule
- POST[Firewall] Apply firewall rules to an instance
- POST[Firewall] Apply a predefined firewall template
- POST[Firewall] Disable all firewall rules
- POST[Firewall] Enable all firewall rules
- GET[Firewall] List available firewall templates
- GET[IP Addresses] List all IP addresses for an instance
- GET[IP Addresses] Get IP address details
- PATCH[IP Addresses] Update IP address configuration
- GET[Snapshots] List all snapshots for an instance
- POST[Snapshots] Create a new snapshot
- GET[Snapshots] Get snapshot details
- PUT[Snapshots] Replace snapshot metadata
- DEL[Snapshots] Delete a snapshot
- PATCH[Snapshots] Partially update snapshot metadata
- POST[Snapshots] Restore an instance from a snapshot
- GET[Software] List installed software on an instance
- POST[Software] Create installed software record
- GET[Software] Get installed software details
- PUT[Software] Replace installed software configuration
- DEL[Software] Delete installed software record
- PATCH[Software] Partially update installed software configuration
- GET[Software] Get installation logs
- GET[Software] Stream installation logs
- POST[Software] Install software on an instance
- GET[Tasks] List instance tasks (nested)
- GET[Tasks] Get instance task (nested)
- GET[SSH Keys] List all SSH keys
- POST[SSH Keys] Add a new SSH key
- GET[SSH Keys] Get SSH key details
- PUT[SSH Keys] Replace SSH key metadata
- DEL[SSH Keys] Delete an SSH key
- PATCH[SSH Keys] Partially update SSH key metadata
- GET[Tasks] List project instance tasks
- GETGet instance task
- GET[Volumes] List all storage volumes
- POST[Volumes] Create a new storage volume
- GET[Volumes] Get storage volume details
- PUT[Volumes] Replace storage volume metadata
- DEL[Volumes] Delete a storage volume
- PATCH[Volumes] Partially update storage volume metadata
- POST[Volumes] Attach a volume to an instance
- POST[Volumes] Detach a volume from an instance
- POST[Volumes] Resize a storage volume
- GET[VPCs] List all Virtual Private Clouds
- POST[VPCs] Create a new Virtual Private Cloud
- GET[VPCs] Get Virtual Private Cloud details
- PUT[VPCs] Replace Virtual Private Cloud
- DEL[VPCs] Delete a Virtual Private Cloud
- PATCH[VPCs] Partially update Virtual Private Cloud
- GET[VPC IPs] List VPC IP allocations
- GET[VPC IPs] Get IP allocation details
- POST[VPC IPs] Allocate IP to instance
- POST[VPC IPs] Release IP from instance
Domains
- GET[Domains] Check domain availability
- GET[Domains] Get domain suggestions
- GET[TLDs] List available TLDs
- GET[TLDs] Check domain availability
- GET[DNS Zones] List all DNS zones
- POST[DNS Zones] Create a new DNS zone
- GET[DNS Zones] Retrieve DNS zone details
- DEL[DNS Zones] Delete a DNS zone
- GET[DNS Zones] Export DNS zone in BIND format
- POST[DNS Zones] Import DNS records from BIND format
- GET[DNS Records] List DNS records for a zone
- POST[DNS Records] Create a new DNS record
- GET[DNS Records] Retrieve DNS record details
- PUT[DNS Records] Update a DNS record
- DEL[DNS Records] Delete a DNS record
- GET[DNS Settings] Get DNS zone settings
- PUT[DNS Settings] Update DNS zone settings
- GET[Domains] List all domains
- GET[Domains] Retrieve domain details
- PUT[Domains] Configure automatic renewal
- PUT[Domains] Update domain WHOIS contacts
- PUT[Domains] Attach DNS zone to domain
- POST[Domains] Activate DNS zone for domain
- POST[Domains] Apply DNS nameservers to domain
- GET[Domains] Verify DNS zone activation status
- GET[Domains] Get EPP authorization code
- POST[Domains] Associate domain with web hosting
- POST[Domains] Disassociate domain from web hosting
- POST[Domains] Enable domain transfer lock
- PUT[Domains] Update domain nameservers
- POST[Domains] Toggle WHOIS privacy protection
- GET[Domains] List domain tasks
- GET[Domains] Retrieve domain task details
- POST[Domains] Disable domain transfer lock
- POST[Domains] Order a domain
Web Hosting
- GET[Hosting Plans] List web hosting plan groups
- GET[Hosting Plans] Retrieve a web hosting plan group
- GET[Hosting Plans] List available web hosting plans
- GET[Hosting Plans] Get web hosting plan details
- GET[Web Hosting] List web hosting accounts
- GET[Web Hosting] Get web hosting details
- GET[Addon Domains] List addon domains
- DEL[Addon Domains] Delete addon domain
- POST[Addon Domains] Create addon domain
- POST[Web Hosting] Request web hosting cancellation
- GET[cPanel] Get cPanel auto-login URL
- POST[Databases] Set database privileges
- GET[Databases] List database users
- DEL[Databases] Delete database user
- POST[Databases] Create database user
- GET[Databases] List MySQL databases
- DEL[Databases] Delete MySQL database
- POST[Databases] Create MySQL database
- GET[Files] Get disk usage
- GET[DNS] List DNS records
- DEL[DNS] Delete DNS record
- POST[DNS] Create DNS record
- PUT[DNS] Edit DNS record
- GET[PHP] List PHP versions per domain
- GET[Emails] List email accounts
- DEL[Emails] Delete email account
- POST[Emails] Change email password
- POST[Emails] Set email quota
- POST[Emails] Create email account
- GET[Files] List files
- GET[FTP] List FTP accounts
- DEL[FTP] Delete FTP account
- POST[FTP] Change FTP password
- POST[FTP] Set FTP quota
- POST[FTP] Create FTP account
- POST[PHP] Set PHP version for domain
- GET[PHP] List available PHP versions
- POST[Web Hosting] Revoke web hosting cancellation
- GET[Web Hosting] List SSL certificates
- GET[Subdomains] List subdomains
- DEL[Subdomains] Delete subdomain
- POST[Subdomains] Create subdomain
- GET[Emails] Get Webmail (Roundcube) auto-login URL
- GET[cPanel] Get WHM auto-login URL
- POST[Web Hosting] Order a web hosting
Organizations
[Domains] Toggle WHOIS privacy protection
curl --request POST \
--url https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/domains/{id}/privacy/{action_type} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"task_type": "register",
"status": "pending",
"created": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}Domains
[Domains] Toggle WHOIS privacy protection
Enable or disable WHOIS privacy protection for a domain. When enabled, the registrant’s personal information (name, address, phone, email) is replaced with proxy contact details in public WHOIS queries. This helps protect against spam and unwanted contact. Note that some TLDs may not support WHOIS privacy or may have specific requirements.
POST
/
v1
/
organizations
/
{organization_id}
/
projects
/
{project_id}
/
domains
/
{id}
/
privacy
/
{action_type}
[Domains] Toggle WHOIS privacy protection
curl --request POST \
--url https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/domains/{id}/privacy/{action_type} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"task_type": "register",
"status": "pending",
"created": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}Documentation Index
Fetch the complete documentation index at: https://help.onetsolutions.net/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).
Path Parameters
Pattern:
^enable|disable$The unique identifier (UUID) of the domain
Response
WHOIS privacy toggle task created and queued for processing
register- registertransfer_in- transfer intransfer_out- transfer outrenew- renewupdate_nameservers- update nameserversupdate_contacts- update contactsget_epp_code- get epp codeenable_whois_privacy- enable whois privacydisable_whois_privacy- disable whois privacylock_domain- lock domainunlock_domain- unlock domaincreate_dns_zone- create dns zonedelete_dns_zone- delete dns zonecreate_dns_record- create dns recordupdate_dns_record- update dns recorddelete_dns_record- delete dns recordsync_dns_records- sync dns records
Available options:
register, transfer_in, transfer_out, renew, update_nameservers, update_contacts, get_epp_code, enable_whois_privacy, disable_whois_privacy, lock_domain, unlock_domain, create_dns_zone, delete_dns_zone, create_dns_record, update_dns_record, delete_dns_record, sync_dns_records pending- pendingrunning- runningcompleted- completedfailed- failedcancelled- cancelled
Available options:
pending, running, completed, failed, cancelled ⌘I